/**
 * KopsoxFramework
 * Copyright (C) 2010 Free Software Foundation, Inc. <http://fsf.org/>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.kopsox.util.xml.data;

import java.util.Collection;
import java.util.Set;

import org.kopsox.util.xml.data.impl.NameNamespaceKey;
import org.kopsox.util.xml.data.impl.NamePriorityDescriptor;

/**
 * @author Konrad Renner - 23.07.2010
 *
 */
public interface XMLContainerDescriptor {
	
	/**
	 * Gets the name of the Class which implements an ValueContainer-Interface
	 * 
	 * @return String
	 */
	public String getClassName();

	/**
	 * Gets the name of the Container
	 * 
	 * @return String
	 */
	public String getName();
	
	/**
	 * Gets the specific namespace of the container
	 * 
	 * @return String
	 */
	public String getNamespace();
	
	/**
	 * Tells if AutoValidation is enabled
	 * 
	 * @return boolean
	 */
	public boolean isAutoValidationEnabled();
	
	/**
	 * Tells if AutoErroDelegation is enabled
	 * 
	 * @return boolean
	 */
	public boolean isAutoErroDelegationEnabled();
	
	/**
	 * Gets the NameNamespaceKey which identifies an Value
	 * 
	 * @return Collection<NameNamespaceKey>
	 */
	public Collection<NameNamespaceKey> getValues();
	
	/**
	 * Gets a Description of the Observers which are mapped to the Value
	 * 
	 * @return Collection<NamePriorityDescriptor>
	 */
	public Collection<NamePriorityDescriptor> getObservers();
	
	/**
	 * Gets the Names of the Key-Elements for the Container
	 * 
	 * @return Set<String>
	 */
	public Set<String> getKeyNames();
	
	/**
	 * Gets a Description of the Validators which are mapped to the Value
	 * 
	 * @return Collection<NamePriorityDescriptor>
	 */
	public Collection<NamePriorityDescriptor> getValidators();
}
